﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class ComplexVoltageExport </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class ComplexVoltageExport ">
    <meta name="generator" content="docfx ">
  
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  
  
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Simulations.ComplexVoltageExport">



  <h1 id="SpiceSharp_Simulations_ComplexVoltageExport" data-uid="SpiceSharp.Simulations.ComplexVoltageExport" class="text-break">Class ComplexVoltageExport</h1>
  <div class="markdown level0 summary"><p>A class that exports complex voltages.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><a class="xref" href="SpiceSharp.Simulations.Export-1.html">Export</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.complex">Complex</a>&gt;</div>
    <div class="level2"><span class="xref">ComplexVoltageExport</span></div>
  </div>
  <div class="implements">
    <h5>Implements</h5>
    <div><a class="xref" href="SpiceSharp.Simulations.IExport-1.html">IExport</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.complex">Complex</a>&gt;</div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.Export-1.html#SpiceSharp_Simulations_Export_1_Simulation">Export&lt;Complex&gt;.Simulation</a>
    </div>
    <div>
      <a class="xref" href="SpiceSharp.Simulations.Export-1.html#SpiceSharp_Simulations_Export_1_Value">Export&lt;Complex&gt;.Value</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.html">SpiceSharp</a>.<a class="xref" href="SpiceSharp.Simulations.html">Simulations</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Simulations_ComplexVoltageExport_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class ComplexVoltageExport : Export&lt;Complex&gt;, IExport&lt;Complex&gt;</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport__ctor_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.#ctor*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport__ctor_SpiceSharp_Simulations_IFrequencySimulation_SpiceSharp_Simulations_Base_Reference_SpiceSharp_Simulations_Base_Reference_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.#ctor(SpiceSharp.Simulations.IFrequencySimulation,SpiceSharp.Simulations.Base.Reference,SpiceSharp.Simulations.Base.Reference)">ComplexVoltageExport(IFrequencySimulation, Reference, Reference)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Simulations.ComplexVoltageExport.html">ComplexVoltageExport</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public ComplexVoltageExport(IFrequencySimulation simulation, Reference posNode, Reference refNode = default)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.IFrequencySimulation.html">IFrequencySimulation</a></td>
        <td><span class="parametername">simulation</span></td>
        <td><p>The simulation.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.Base.Reference.html">Reference</a></td>
        <td><span class="parametername">posNode</span></td>
        <td><p>The positive node (can be a string or a string array for a path).</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.Base.Reference.html">Reference</a></td>
        <td><span class="parametername">refNode</span></td>
        <td><p>The reference/negative node (can be a string or a string array for a path).</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="exceptions">Exceptions</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Condition</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentnullexception">ArgumentNullException</a></td>
        <td><p>Thrown if <code class="paramref">simulation</code> is <code>null</code>.</p>
</td>
      </tr>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.argumentexception">ArgumentException</a></td>
        <td><p>Thrown if <code class="paramref">posNode</code> and <code class="paramref">refNode</code> are both empty.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_Decibels_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Decibels*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_Decibels" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Decibels">Decibels</h4>
  <div class="markdown level1 summary"><p>Gets the amplitude in decibels (dB).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Complex Decibels { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.complex">Complex</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_Phase_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Phase*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_Phase" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Phase">Phase</h4>
  <div class="markdown level1 summary"><p>Gets the phase in radians.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Complex Phase { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.complex">Complex</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_Positive_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Positive*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_Positive" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Positive">Positive</h4>
  <div class="markdown level1 summary"><p>Gets the positive node.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Reference Positive { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.Base.Reference.html">Reference</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_Reference_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Reference*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_Reference" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.Reference">Reference</h4>
  <div class="markdown level1 summary"><p>Gets the reference node.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Reference Reference { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.Base.Reference.html">Reference</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
</h3>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_BuildExtractor_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.BuildExtractor*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_BuildExtractor_SpiceSharp_Simulations_ISimulation_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.BuildExtractor(SpiceSharp.Simulations.ISimulation)">BuildExtractor(ISimulation)</h4>
  <div class="markdown level1 summary"><p>Builds the extractor for the given simulation.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected override Func&lt;Complex&gt; BuildExtractor(ISimulation simulation)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="SpiceSharp.Simulations.ISimulation.html">ISimulation</a></td>
        <td><span class="parametername">simulation</span></td>
        <td><p>The simulation.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.func-1">Func</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.numerics.complex">Complex</a>&gt;</td>
        <td><p>The extractor.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="SpiceSharp.Simulations.Export-1.html#SpiceSharp_Simulations_Export_1_BuildExtractor_SpiceSharp_Simulations_ISimulation_">Export&lt;Complex&gt;.BuildExtractor(ISimulation)</a></div>
  <a id="SpiceSharp_Simulations_ComplexVoltageExport_ToString_" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.ToString*"></a>
  <h4 id="SpiceSharp_Simulations_ComplexVoltageExport_ToString" data-uid="SpiceSharp.Simulations.ComplexVoltageExport.ToString">ToString()</h4>
  <div class="markdown level1 summary"><p>Converts the export to a string.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public override string ToString()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
        <td><p>The string.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 class="overrides">Overrides</h5>
  <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a></div>
  <h3 id="implements">Implements</h3>
  <div>
      <a class="xref" href="SpiceSharp.Simulations.IExport-1.html">IExport&lt;T&gt;</a>
  </div>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, string)</a>
  </div>
  <h3 id="seealso">See Also</h3>
  <div class="seealso">
      <div><a class="xref" href="SpiceSharp.Simulations.Export-1.html">Export</a>&lt;T&gt;</div>
  </div>

</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In this article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
